home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIWebProgress.idl < prev    next >
Text File  |  2006-05-08  |  7KB  |  173 lines
  1. /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2.  *
  3.  * ***** BEGIN LICENSE BLOCK *****
  4.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5.  *
  6.  * The contents of this file are subject to the Mozilla Public License Version
  7.  * 1.1 (the "License"); you may not use this file except in compliance with
  8.  * the License. You may obtain a copy of the License at
  9.  * http://www.mozilla.org/MPL/
  10.  *
  11.  * Software distributed under the License is distributed on an "AS IS" basis,
  12.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13.  * for the specific language governing rights and limitations under the
  14.  * License.
  15.  *
  16.  * The Original Code is the Mozilla browser.
  17.  *
  18.  * The Initial Developer of the Original Code is
  19.  * Netscape Communications, Inc.
  20.  * Portions created by the Initial Developer are Copyright (C) 1999
  21.  * the Initial Developer. All Rights Reserved.
  22.  *
  23.  * Contributor(s):
  24.  *   Travis Bogard <travis@netscape.com>
  25.  *   Darin Fisher <darin@meer.net>
  26.  *
  27.  * Alternatively, the contents of this file may be used under the terms of
  28.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  29.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30.  * in which case the provisions of the GPL or the LGPL are applicable instead
  31.  * of those above. If you wish to allow use of your version of this file only
  32.  * under the terms of either the GPL or the LGPL, and not to allow others to
  33.  * use your version of this file under the terms of the MPL, indicate your
  34.  * decision by deleting the provisions above and replace them with the notice
  35.  * and other provisions required by the GPL or the LGPL. If you do not delete
  36.  * the provisions above, a recipient may use your version of this file under
  37.  * the terms of any one of the MPL, the GPL or the LGPL.
  38.  *
  39.  * ***** END LICENSE BLOCK ***** */
  40.  
  41. #include "nsISupports.idl"
  42.  
  43. interface nsIDOMWindow;
  44. interface nsIWebProgressListener;
  45.  
  46. /**
  47.  * The nsIWebProgress interface is used to add or remove nsIWebProgressListener
  48.  * instances to observe the loading of asynchronous requests (usually in the
  49.  * context of a DOM window).
  50.  *
  51.  * nsIWebProgress instances may be arranged in a parent-child configuration,
  52.  * corresponding to the parent-child configuration of their respective DOM
  53.  * windows.  However, in some cases a nsIWebProgress instance may not have an
  54.  * associated DOM window.  The parent-child relationship of nsIWebProgress
  55.  * instances is not made explicit by this interface, but the relationship may
  56.  * exist in some implementations.
  57.  *
  58.  * A nsIWebProgressListener instance receives notifications for the
  59.  * nsIWebProgress instance to which it added itself, and it may also receive
  60.  * notifications from any nsIWebProgress instances that are children of that
  61.  * nsIWebProgress instance.
  62.  *
  63.  * @status FROZEN
  64.  */
  65. [scriptable, uuid(570F39D0-EFD0-11d3-B093-00A024FFC08C)]
  66. interface nsIWebProgress : nsISupports
  67. {
  68.   /**
  69.    * The following flags may be combined to form the aNotifyMask parameter for
  70.    * the addProgressListener method.  They limit the set of events that are
  71.    * delivered to an nsIWebProgressListener instance.
  72.    */ 
  73.  
  74.   /**
  75.    * These flags indicate the state transistions to observe, corresponding to
  76.    * nsIWebProgressListener::onStateChange.
  77.    *
  78.    * NOTIFY_STATE_REQUEST
  79.    *   Only receive the onStateChange event if the aStateFlags parameter
  80.    *   includes nsIWebProgressListener::STATE_IS_REQUEST.
  81.    *   
  82.    * NOTIFY_STATE_DOCUMENT
  83.    *   Only receive the onStateChange event if the aStateFlags parameter
  84.    *   includes nsIWebProgressListener::STATE_IS_DOCUMENT.
  85.    *
  86.    * NOTIFY_STATE_NETWORK
  87.    *   Only receive the onStateChange event if the aStateFlags parameter
  88.    *   includes nsIWebProgressListener::STATE_IS_NETWORK.
  89.    *
  90.    * NOTIFY_STATE_WINDOW
  91.    *   Only receive the onStateChange event if the aStateFlags parameter
  92.    *   includes nsIWebProgressListener::STATE_IS_WINDOW.
  93.    *
  94.    * NOTIFY_STATE_ALL
  95.    *   Receive all onStateChange events.
  96.    */
  97.   const unsigned long NOTIFY_STATE_REQUEST  = 0x00000001;
  98.   const unsigned long NOTIFY_STATE_DOCUMENT = 0x00000002;
  99.   const unsigned long NOTIFY_STATE_NETWORK  = 0x00000004;
  100.   const unsigned long NOTIFY_STATE_WINDOW   = 0x00000008;
  101.   const unsigned long NOTIFY_STATE_ALL      = 0x0000000f;
  102.  
  103.   /**
  104.    * These flags indicate the other events to observe, corresponding to the
  105.    * other four methods defined on nsIWebProgressListener.
  106.    *
  107.    * NOTIFY_PROGRESS
  108.    *   Receive onProgressChange events.
  109.    *
  110.    * NOTIFY_STATUS
  111.    *   Receive onStatusChange events.
  112.    *
  113.    * NOTIFY_SECURITY
  114.    *   Receive onSecurityChange events.
  115.    *
  116.    * NOTIFY_LOCATION
  117.    *   Receive onLocationChange events.
  118.    */
  119.   const unsigned long NOTIFY_PROGRESS       = 0x00000010;
  120.   const unsigned long NOTIFY_STATUS         = 0x00000020;
  121.   const unsigned long NOTIFY_SECURITY       = 0x00000040;
  122.   const unsigned long NOTIFY_LOCATION       = 0x00000080;
  123.  
  124.   /**
  125.    * This flag enables all notifications.
  126.    */
  127.   const unsigned long NOTIFY_ALL            = 0x000000ff;
  128.  
  129.   /**
  130.    * Registers a listener to receive web progress events.
  131.    *
  132.    * @param aListener
  133.    *        The listener interface to be called when a progress event occurs.
  134.    *        This object must also implement nsISupportsWeakReference.
  135.    * @param aNotifyMask
  136.    *        The types of notifications to receive.
  137.    *
  138.    * @throw NS_ERROR_INVALID_ARG
  139.    *        Indicates that aListener was either null or that it does not
  140.    *        support weak references.
  141.    * @throw NS_ERROR_FAILURE
  142.    *        Indicates that aListener was already registered.
  143.    */
  144.   void addProgressListener(in nsIWebProgressListener aListener,
  145.                            in unsigned long aNotifyMask);
  146.  
  147.   /**
  148.    * Removes a previously registered listener of progress events.
  149.    *
  150.    * @param aListener
  151.    *        The listener interface previously registered with a call to
  152.    *        addProgressListener.
  153.    *
  154.    * @throw NS_ERROR_FAILURE
  155.    *        Indicates that aListener was not registered.
  156.    */
  157.   void removeProgressListener(in nsIWebProgressListener aListener);
  158.  
  159.   /**
  160.    * The DOM window associated with this nsIWebProgress instance.
  161.    *
  162.    * @throw NS_ERROR_FAILURE
  163.    *        Indicates that there is no associated DOM window.
  164.    */
  165.   readonly attribute nsIDOMWindow DOMWindow;
  166.   
  167.   /**
  168.    * Indicates whether or not a document is currently being loaded
  169.    * in the context of this nsIWebProgress instance.
  170.    */
  171.   readonly attribute PRBool isLoadingDocument;
  172. };
  173.